Fix type hint for SymbolicReference.reference property#2074
Merged
Byron merged 1 commit intogitpython-developers:mainfrom Sep 30, 2025
emmanuel-ferdman:main
Merged
Fix type hint for SymbolicReference.reference property#2074Byron merged 1 commit intogitpython-developers:mainfrom emmanuel-ferdman:main
SymbolicReference.reference property#2074Byron merged 1 commit intogitpython-developers:mainfrom
emmanuel-ferdman:main
Conversation
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Member
|
Thanks a lot, looks good to me! Besides that, we do have mypi type checks, but it seems like they are advisory only and can't fail CI. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
This PR fixes mypy errors introduced in v3.1.45 where code like
repo.head.ref.checkout()fails type checking even though it works at runtime. The issue is thatSymbolicReference.referencewas typed to returnSymbolicReference, but it actually returnsReferencesubclasses that have methods likecheckout()andtracking_branch(). Changed the return type annotation fromSymbolicReferencetoReferenceand added an explicit cast in_get_reference()to match what actually happens at runtime. This is a type-only change with no behavioral impact.Fixes #2066.